<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>BasicMapCacheProvider xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/test/BasicMapCacheProvider.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: BasicMapCacheProvider.html 11 2009-01-29 14:58:33Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://genericdao.googlecode.com/svn/maven/site/xref-test/org/sakaiproject/genericdao/test/BasicMapCacheProvider.html $</em>
<a name="4" href="#4">4</a>   <em> * BasicMapCacheProvider.java - genericdao - May 14, 2008 12:23:29 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2.0</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski@gmail.com) (aaronz@vt.edu) (aaron@caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.test;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.util.HashMap;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.List;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.Map;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.Vector;
<a name="21" href="#21">21</a>  <strong>import</strong> java.util.concurrent.ConcurrentHashMap;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> org.sakaiproject.genericdao.api.caching.CacheKeyNotFoundException;
<a name="24" href="#24">24</a>  <strong>import</strong> org.sakaiproject.genericdao.api.caching.CacheProvider;
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  <em>/**<em>*</em></em>
<a name="27" href="#27">27</a>  <em> * This is a very simple in memory map cache,</em>
<a name="28" href="#28">28</a>  <em> * it is meant for use in testing and as an example only</em>
<a name="29" href="#29">29</a>  <em> * </em>
<a name="30" href="#30">30</a>  <em> * @author Aaron Zeckoski (azeckoski@gmail.com)</em>
<a name="31" href="#31">31</a>  <em> */</em>
<a name="32" href="#32">32</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/genericdao/test/BasicMapCacheProvider.html">BasicMapCacheProvider</a> implements CacheProvider {
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>     <strong>private</strong> Map&lt;String, Map&lt;String, Object>> cache = <strong>new</strong> ConcurrentHashMap&lt;String, Map&lt;String,Object>>();
<a name="35" href="#35">35</a>  
<a name="36" href="#36">36</a>     <strong>protected</strong> List&lt;String> actionRecord = <strong>new</strong> Vector&lt;String>();
<a name="37" href="#37">37</a>     <strong>public</strong> List&lt;String> getActionRecord() {
<a name="38" href="#38">38</a>        <strong>return</strong> actionRecord;
<a name="39" href="#39">39</a>     }
<a name="40" href="#40">40</a>     <strong>public</strong> String getLastAction() {
<a name="41" href="#41">41</a>        String action = <strong>null</strong>;
<a name="42" href="#42">42</a>        <strong>if</strong> (actionRecord.size() > 0) {
<a name="43" href="#43">43</a>           action = actionRecord.get(actionRecord.size()-1);
<a name="44" href="#44">44</a>        }
<a name="45" href="#45">45</a>        <strong>return</strong> action;
<a name="46" href="#46">46</a>     }
<a name="47" href="#47">47</a>     <strong>public</strong> <strong>int</strong> size(String cacheName) {
<a name="48" href="#48">48</a>        checkCacheName(cacheName);
<a name="49" href="#49">49</a>        <strong>return</strong> cache.get(cacheName).size();      
<a name="50" href="#50">50</a>     }
<a name="51" href="#51">51</a>     <strong>public</strong> <strong>void</strong> reset() {
<a name="52" href="#52">52</a>        <strong>for</strong> (Map&lt;String, Object> m : cache.values()) {
<a name="53" href="#53">53</a>           m.clear();
<a name="54" href="#54">54</a>        }
<a name="55" href="#55">55</a>        actionRecord.clear();
<a name="56" href="#56">56</a>     }
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>     <strong>public</strong> <strong>void</strong> clear(String cacheName) {
<a name="59" href="#59">59</a>        checkCacheName(cacheName);
<a name="60" href="#60">60</a>        cache.get(cacheName).clear();
<a name="61" href="#61">61</a>        actionRecord.add(<span class="string">"clear:"</span> + cacheName);
<a name="62" href="#62">62</a>     }
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>     <strong>public</strong> <strong>void</strong> createCache(String cacheName) {
<a name="65" href="#65">65</a>        <strong>if</strong> (cacheName == <strong>null</strong>) {
<a name="66" href="#66">66</a>           <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"cacheName cannot be null"</span>);
<a name="67" href="#67">67</a>        }
<a name="68" href="#68">68</a>        <strong>if</strong> (! cache.containsKey(cache)) {
<a name="69" href="#69">69</a>           Map&lt;String, Object> iCache = <strong>new</strong> HashMap&lt;String, Object>();
<a name="70" href="#70">70</a>           cache.put(cacheName, iCache);
<a name="71" href="#71">71</a>           actionRecord.add(<span class="string">"create:"</span> + cacheName + <span class="string">":new"</span>);
<a name="72" href="#72">72</a>        } <strong>else</strong> {
<a name="73" href="#73">73</a>           cache.get(cacheName).clear();
<a name="74" href="#74">74</a>           actionRecord.add(<span class="string">"create:"</span> + cacheName + <span class="string">":clear"</span>);
<a name="75" href="#75">75</a>        }
<a name="76" href="#76">76</a>     }
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>     <strong>public</strong> <strong>boolean</strong> exists(String cacheName, String key) {
<a name="79" href="#79">79</a>        checkCacheName(cacheName);
<a name="80" href="#80">80</a>        <strong>boolean</strong> exists = cache.get(cacheName).containsKey(key);
<a name="81" href="#81">81</a>        actionRecord.add(<span class="string">"exists: "</span> + cacheName + <span class="string">":"</span> + key + <span class="string">":exists="</span> + exists);
<a name="82" href="#82">82</a>        <strong>return</strong> exists;
<a name="83" href="#83">83</a>     }
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>     <strong>public</strong> Object get(String cacheName, String key) {
<a name="86" href="#86">86</a>        checkCacheName(cacheName);
<a name="87" href="#87">87</a>        <strong>if</strong> (! cache.get(cacheName).containsKey(key)) {
<a name="88" href="#88">88</a>           <strong>throw</strong> <strong>new</strong> CacheKeyNotFoundException(<span class="string">"Key ("</span>+key+<span class="string">") does not exist in cache ("</span>+cacheName+<span class="string">")"</span>, cacheName, key);
<a name="89" href="#89">89</a>        }
<a name="90" href="#90">90</a>        actionRecord.add(<span class="string">"get: "</span> + cacheName + <span class="string">":"</span> + key);
<a name="91" href="#91">91</a>        <strong>return</strong> cache.get(cacheName).get(key);
<a name="92" href="#92">92</a>     }
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>     <strong>public</strong> <strong>void</strong> put(String cacheName, String key, Object value) {
<a name="95" href="#95">95</a>        checkCacheName(cacheName);
<a name="96" href="#96">96</a>        <strong>if</strong> (key == <strong>null</strong>) {
<a name="97" href="#97">97</a>           <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"key cannot be null"</span>);
<a name="98" href="#98">98</a>        }
<a name="99" href="#99">99</a>        actionRecord.add(<span class="string">"put: "</span> + cacheName + <span class="string">":"</span> + key + <span class="string">":value="</span> + value);
<a name="100" href="#100">100</a>       cache.get(cacheName).put(key, value);
<a name="101" href="#101">101</a>    }
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>    <strong>public</strong> <strong>boolean</strong> remove(String cacheName, String key) {
<a name="104" href="#104">104</a>       checkCacheName(cacheName);
<a name="105" href="#105">105</a>       <strong>boolean</strong> exists = false;
<a name="106" href="#106">106</a>       <strong>if</strong> (cache.get(cacheName).containsKey(key)) {
<a name="107" href="#107">107</a>          exists = <strong>true</strong>;
<a name="108" href="#108">108</a>          cache.get(cacheName).remove(key);
<a name="109" href="#109">109</a>       }
<a name="110" href="#110">110</a>       actionRecord.add(<span class="string">"remove: "</span> + cacheName + <span class="string">":"</span> + key + <span class="string">":removed="</span> + exists);
<a name="111" href="#111">111</a>       <strong>return</strong> exists;
<a name="112" href="#112">112</a>    }
<a name="113" href="#113">113</a> 
<a name="114" href="#114">114</a>    <strong>private</strong> <strong>void</strong> checkCacheName(String cacheName) {
<a name="115" href="#115">115</a>       <strong>if</strong> (cacheName == <strong>null</strong>) {
<a name="116" href="#116">116</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"cacheName cannot be null"</span>);
<a name="117" href="#117">117</a>       }
<a name="118" href="#118">118</a>       <strong>if</strong> (! cache.containsKey(cacheName)) {
<a name="119" href="#119">119</a>          <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid cache name: "</span> + cacheName);
<a name="120" href="#120">120</a>       }
<a name="121" href="#121">121</a>    }
<a name="122" href="#122">122</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

